docs: merge cookiecutter page, add CI/CD and testing docs#41
Conversation
…d testing docs - Replace Cookiecutter Reference page with redirect to Getting Started - Add CI/CD section (GitHub Actions + GitLab CI) to Getting Started - Add CI/CD row to home page "What You Get Out of the Box" table - Add new Testing how-to (unit tests, mocks, benchmarks, coverage) - Update all cookiecutter link references to point to /getting-started - Update Playwright test expectations
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughThe PR consolidates Cookiecutter documentation by redirecting its dedicated reference page to Getting Started, updates link references across multiple howto pages from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
tests/navigation.spec.ts (1)
15-30:⚠️ Potential issue | 🟡 MinorAdd an explicit redirect test for
/cookiecutter-reference/.Line 29 adds new page coverage, but the suite no longer validates the redirect behavior called out in the PR objectives. Please add a dedicated redirect assertion so this behavior stays protected.
✅ Suggested test addition
test.describe("Page Loading", () => { + test("cookiecutter reference redirects to getting-started", async ({ page }) => { + const response = await page.goto("/cookiecutter-reference/"); + expect(response?.status()).toBe(200); // static-site redirect page may return 200 + await expect(page).toHaveURL(/\/getting-started\/?$/); + }); + for (const page of topLevelPages) {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@tests/navigation.spec.ts` around lines 15 - 30, Add a new explicit test in tests/navigation.spec.ts that asserts the redirect behavior for "/cookiecutter-reference/": locate the navigation test that iterates over howtoPages (variable howtoPages) and add a separate case that visits "/cookiecutter-reference/" and asserts the expected redirect target (status or final URL/location) rather than relying on the generic pages list; ensure the test uses the same test framework helpers/assertions as the other navigation checks so the redirect behavior is covered independently from the howtoPages array.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@Cookiecutter.md`:
- Around line 10-12: The page currently uses a client-side meta refresh (<meta
http-equiv="refresh" content="0; url=/getting-started/">) which is not an HTTP
redirect; remove that meta refresh line from Cookiecutter.md and configure a
proper 3xx redirect for the /cookiecutter-reference route in your hosting/server
config (e.g., Netlify/Vercel redirect, nginx/Apache rule, or static-site
redirect file) to point to /getting-started/, leaving the textual fallback
("This page has moved...") in Cookiecutter.md if you still want a human-readable
page.
In `@quickstart.md`:
- Around line 299-305: The doc currently lists the CI job "lint" as running
`make vulncheck` + golangci-lint while other sections reference `make lint`
(including govulncheck); pick one canonical command (preferably `make lint`) and
update the table entry and any other occurrences to match: ensure the Job column
entry "**lint**" and its description reference the single chosen make target
(`make lint`) and mention the tools it runs (golangci-lint and
govulncheck/vulncheck) consistently, and update any other lines that refer to
`make vulncheck` so all references use the same command name and tooling
description.
---
Outside diff comments:
In `@tests/navigation.spec.ts`:
- Around line 15-30: Add a new explicit test in tests/navigation.spec.ts that
asserts the redirect behavior for "/cookiecutter-reference/": locate the
navigation test that iterates over howtoPages (variable howtoPages) and add a
separate case that visits "/cookiecutter-reference/" and asserts the expected
redirect target (status or final URL/location) rather than relying on the
generic pages list; ensure the test uses the same test framework
helpers/assertions as the other navigation checks so the redirect behavior is
covered independently from the howtoPages array.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 147d597c-6b21-460e-8023-91d3db3042d9
📒 Files selected for processing (15)
Cookiecutter.mdIndex.mdhowto/APIs.mdhowto/Log.mdhowto/Tracing.mdhowto/gRPC.mdhowto/interceptors.mdhowto/production.mdhowto/signals.mdhowto/swagger.mdhowto/testing.mdhowto/vtproto.mdintegrations.mdquickstart.mdtests/navigation.spec.ts
There was a problem hiding this comment.
Pull request overview
Updates the ColdBrew docs site to consolidate Cookiecutter guidance into Getting Started, add CI/CD and testing documentation, and keep internal links/tests aligned with the new structure.
Changes:
- Replaced the Cookiecutter Reference page content with a redirect to Getting Started and updated all “ColdBrew cookiecutter” references.
- Expanded Getting Started with CI/CD details (GitHub Actions + GitLab CI) and added a new Testing how-to page.
- Updated the home page feature table and Playwright navigation expectations for the new docs page(s).
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
tests/navigation.spec.ts |
Updates navigation coverage by removing Cookiecutter page and adding the new testing page path. |
quickstart.md |
Adds CI/CD documentation, expands generated project tree, and links to the new Testing how-to. |
integrations.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/vtproto.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/testing.md |
Adds a new Testing guide (unit tests, mockery, benchmarks, coverage). |
howto/swagger.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/signals.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/production.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/interceptors.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/gRPC.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/Tracing.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/Log.md |
Updates Cookiecutter reference link to point at Getting Started. |
howto/APIs.md |
Updates Cookiecutter reference link to point at Getting Started. |
Index.md |
Adds CI/CD row to the “What You Get Out of the Box” table and supporting link refs. |
Cookiecutter.md |
Converts the Cookiecutter Reference page into a redirect stub. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Use layout: null with proper HTML head for cookiecutter redirect - Add JS fallback for redirect - Fix lint job description inconsistency (govulncheck, not make vulncheck) - Clarify config.Get() vs config.GetColdBrewConfig() in testing how-to - Add Playwright test for /cookiecutter-reference redirect
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 17 out of 17 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Test plan
/cookiecutter-referenceredirects to/getting-started/howto/testing/page renders correctlynpx playwright test— all navigation tests pass[ColdBrew cookiecutter]linksSummary by CodeRabbit
Documentation
Tests